Visualization Element: Image Switcher

Symbol:

Category: Lamps/Switches/Bitmaps

The element displays one of three referenced images. Mouse actions change the displayed image. The images are defined in the Image settings element properties. The effects of mouse clicks are defined in the Element behavior property.

Element properties

Are all element properties available?

All properties are available only after you select the Advanced option or the All categories filter in Properties.

Element name	Example: `ImageSwitcher_1` Tip Assign individual names for elements so that they are found faster in the element list.
Element Type	Image Switcher

Position

The position defines the location and size of the element in the visualization window. This is based on the Cartesian coordinate system. The origin is located in the upper left corner of the window. The positive horizontal X-axis runs to the right. The positive vertical Y-axis runs downwards.

X	The X-coordinate (in pixels) of the upper left corner of the element Example: `10`
Y	The Y-coordinate (in pixels) of the upper left corner of the element Example: `10`
Width	Specified in pixels Example: `150`
Height	Specified in pixels Example: `30`

Tip

You can also change the values by dragging the box symbols to other positions in the editor.

Variable

Variable (BOOL).

The value of the variable changes according to user input and it is independent of the Element behavior element property.

Image Settings

Image, if "on"	ID of a specific image from an image pool The image is used if the variable of the Variable property has the value `TRUE`. Tip You can also select the image by using the Input Assistant.
Image, if "off"	ID of a specific image from an image pool The image is used if the variable of the Variable property has the value `FALSE`. Tip You can also select the image by using the Input Assistant.
Image, if "pushed"	Requirement: The Element behavior is set to Image toggler. ID of a specific image from an image pool At runtime, the visualization displays the referenced image when the element is clicked (and the mouse button is held down). Tip You can also select the image by using the Input Assistant.
Transparency	: The Transparent color is selected.
Transparent color	Requirement: Transparency is activated. Pixels of the image which have the transparent color are displayed as transparent. : The Color dialog opens. : A list box with color names opens.
Scaling type	Defines how an image fits into the element frame Fixed: The original size of the image is retained, regardless of the element size. Isotropic: The entire image is displayed in the element frame, either larger or smaller. As a result, the proportion of height and width are retained. Anisotropic: The image resizes automatically to the dimensions of the element frame, filling the entire element frame. As a result, the proportions are not retained.
Horizontal alignment	Requirement: The Scaling type is Isotropic. Horizontal alignment of the image within the element frame or element Left Centered Right
Vertical alignment	Requirement: The Scaling type is Isotropic. Vertical alignment of the image within the element frame or element Top Centered Bottom

Element Behavior

Element behavior

Image switcher: The image in switches with each mouse click.
Image tapper: While a visualization user holds down the mouse button, the image of the Image on property is displayed. At the same time, the value TRUE is assigned to the Variable property.

Tap FALSE

standard icon : : While the mouse button is pressed, the image of the Image property is displayed and the Variable property gets the value FALSE instead of the value TRUE, and back.

Requirement: Image tapper is selected in the Element behavior property.

Texts

Tooltip

String (without single straight quotation marks)

Example: Products of customer A

The text is output as a tooltip. If a placeholder %<format string> is specified in the text, then the value of the variable in the Text variable → Tooltip property is output at the location of the placeholder.

Tip

Use the Ctrl+Enter shortcut to add a line break.

Tip

The specified texts are automatically transferred to the GlobalTextList text list. Therefore, these texts can be localized.

Blinking

The value in Blink interval specifies the interval in milliseconds in which the element changes between the image for the switched-on state and the image for the switched-off state.

Requirement: The visualization is run as WebVisu and the Support client animations and overlay of native elements option in the Visualization Manager is enabled. The element can blink only in this context.

For more information, see: Group: General Settings

Blink interval

Blink interval in milliseconds (ms) for the images transferred to Image Settings

At 0 (default setting), the element does not blink, but the image for the switched-on state (Image, if "on" property) is displayed permanently.

Variable (type UDINT) for a program-controlled change of image
Example: PLC_PRG.udiBlinking
Literal (type UDINT),
Defines the time interval in which the image for the switched-on state changes to the image for the switched-off state
Example: 1000 for 1 s

State variables

The variables control the element behavior dynamically.

Invisible

Variable (BOOL) for toggling the visibility of the element

TRUE: The element is not visible at runtime.

Example: bIsVisible with VAR bIsVisible : BOOL := FALSE; END_VAR

Deactivate inputs

Variable (BOOL) for toggling the operability of the element

TRUE: User inputs do not have any effect in runtime more. The element is shown as deactivated.

Tip

The Invisible property is supported by the "Client Animation" functionality.

Center

	The properties contain fixed values for the coordinates of the point of rotation. The rotation point is displayed in the editor as the symbol and is used as the center for rotation and scaling. Tip You can also change the values by dragging the symbol to another position in the editor.
X	X-coordinate of the point of rotation
Y	Y-coordinate of the point of rotation

Absolute movement

The properties contain IEC variables for controlling the position of the element dynamically. The reference point is the upper left corner of the element. At runtime, the entire element is moved.

Movement
X	Variable (numeric data type) for the X-position (in pixels) Example: `PLC_PRG.iPos_X`. Container variable: `Container.Width` For more information, see: Optimally Adjusting the Position and Size Increasing this value at runtime moves the element to the right.
Y	Variable (numeric data type) for the Y-position (in pixels) Example: `PLC_PRG.iPos_Y`. Container variable: `Container.Height` For more information, see: Optimally Adjusting the Position and Size Increasing this value at runtime moves the element downwards.
Rotation	Variable (numeric data type) for the angle of rotation (in degrees) Example: `PLC_PRG.iAngle1`. The midpoint of the element rotates at the Center point. This rotation point is shown as the symbol. At runtime, the alignment of the element remains the same with respect to the coordinate system of the visualization. Increasing the value rotates the element to the right.
Scaling	Variable (integer data type) to trigger a centric stretching Example: `PLC_PRG.iScaling` The reference point is the Center property. The value `1` shrinks the element by a factor of `0.001`. The value `1000` returns the element to its original size.
Interior rotation	Variable (numeric data type) for the angle of rotation (in degrees) Example: `PLC_PRG.iAngle2`. At runtime, the element rotates about the point of rotation specified in Center according to the value of the variable. In addition, the alignment of the element rotates according to the coordinate system of the visualization. Increasing the value in the code rotates clockwise. The rotation point is shown as the symbol. Note If a static angle of rotation is specified in the Position → Angle property, then the static angle of rotation is added to the variable angle of rotation (offset) when the visualization is executed.

Tip

You can combine the variables to a Unit conversion.

Tip

The X, Y, Rotation, and Interior rotation properties are supported by the "Client Animation" functionality.

Animation

Tip

These properties are available only when you have selected the Support client animations and overlay of native elements option in the Visualization Manager.

Animation duration

Variable for the duration (in milliseconds) in which the element runs an animation

Variable (integer value)
Example: Menu.tContent with VAR tContent : INT := 500; END_VAR
Integer literal
Example: 500

. Animatable properties

Absolute movement, Movement, X, Y
Absolute movement, Rotation
Absolute movement, Interior rotation
Absolute movement, Exterior rotation

The animated movement is executed when at least one value of an animatable property has changed. The movement then executed is not jerky, but is smooth within the specified animation duration. The visualization element travels to the specified position while rotating dynamically. The transitions are smooth.

Move to foreground

Variable (BOOL) for setting the element in the foreground

TRUE: At runtime, the visualization element is displayed in the foreground.

FALSE: At runtime, the visualization element is displayed in the layer where it was inserted in the visualization editor.

Example: bIsInForeground with VAR bIsInForeground : BOOL := FALSE; END_VAR

Input Configuration

The properties contain the configurations for the user input when using the mouse or keyboard. A user input defines an event and one or more actions that are executed when an event occurs.

Tip The Configure button opens the Input Configuration dialog. There you can create or edit user inputs. Configured user inputs are listed below the events. They each include the action that is triggered and the setting in short form. Example: Execute ST Code: `PLC_PRG.i_x := 0;`
OnDialogClosed	Input event: The user closes the dialog.
OnMouseClick	Input event: The user clicks the mouse button completely in the element area. The mouse button is clicked and released.
OnMouseDown	Input event: The user clicks down on the mouse button.
OnMouseEnter	Input event: The user drags the mouse pointer to the element.
OnMouseLeave	Input event: The user drags the mouse pointer away from the element.
OnMouseMove	Input event: The user moves the mouse pointer over the element area.
OnMouseUp	. Input events: The user releases the mouse button within the element area. It is irrelevant whether the user has previously pressed the mouse button inside or outside the element area. The user presses the mouse button within the element area, leaves the element area, and then releases the mouse button. Note This CODESYS-specific triggering behavior guarantees that actions for key elements are completed. A key element starts an action for OnMouseDown and ends the action for OnMouseUp. Example: A visualization user presses the mouse button within the element area of the key element and then moves the cursor position so that it is located outside of the element area. The action is ended anyway because OnMouseUp is triggered.

Tap	When a mouse click event occurs, the variable defined in Variable is described in the application. The coding depends on the Tap FALSE and Tap on enter if captured options.
Variable	Requirement: The Tap FALSE option is not activated. Variable (`BOOL`) for the mouse click event `TRUE`: A mouse click event exists. It lasts as long as the user presses the mouse button over the element. It ends when the button is released. `FALSE`: A mouse click event does not exist. Example: `PLC_PRG.bIsTapped`
Tap FALSE	: The mouse click event leads to a complementary value in Variable. `TRUE`: A mouse click event does not exist. `FALSE`: While the mouse click event exists.
Tap on enter if captured	: During user input, it is also taken into consideration whether the mouse pointer is dragged within the element area or not while the mouse button is pressed. `TRUE`: While the mouse click event exists and the mouse pointer is moved over the element area. `FALSE`: A mouse click event does not exist. Or the user moves the mouse pointer outside of the element area while the mouse button is pressed. The value is `TRUE` again as soon as the user moves the pointer back to the element area. The mouse is then captured.

Switch over

With the onset of a mouse click event, the variable is set; when the mouse click event is completed, the variable is reset.

Variable

Variable (BOOL) for toggling at the end of the mouse click event

This is when the user releases the mouse button while the mouse pointer is over the element area.If the user releases the mouse button while the mouse pointer is outside of the element area, then the mouse click event is not ended and the value is not toggled.

Tip

The user can cancel a started toggle input by dragging the mouse pointer out of the element area.

Toggle on up if captured

standard icon : The value toggles regardless of where the mouse pointer is when the mouse button is released. The mouse is then captured.

Hotkey	Shortcut on the element for triggering specific input actions When the hotkey event occurs, the input actions in the Events property are triggered. In this way, it is not the input action itself that leads to this input action, but the mouse input action.
Key	Key pressed for input action. Example: T The following properties appear when a key is selected.
Events	None Mouse down: Pressing the key triggers the input actions that are configured in the OnMouseDown property. Mouse up: Releasing the key triggers the input actions that are configured in the OnMouseUp property. Mouse down/up: Pressing and releasing the key triggers the input actions that are configured in the OnMouseDown property and the OnMouseUp property.
Switch over	: Combination with the "Shift" key Example: Shift+T.
Control	: Combination with the "Ctrl" key Example: Ctrl+T.
Alt	: Combination with the "Alt" key Example: Alt+T.

Tip

All keyboard shortcuts and their actions that are configured in the visualization are listed on the Keyboard Configuration tab.

Access Rights

Note

Available only when a user management is set up for visualization.

Access Rights button

Opens the Access Rights dialog. There you can edit the access privileges for the element.

. Status messages:

Not set. Full rights.: Access rights for all user groups : operable
Rights are set: Limited rights: Access is restricted for at least one group.